Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

improve dalapi parser by warning undocumented instance [issue-1162] #1737

Closed
wants to merge 7 commits into from
Closed

improve dalapi parser by warning undocumented instance [issue-1162] #1737

wants to merge 7 commits into from

Conversation

cmsxbc
Copy link
Contributor

@cmsxbc cmsxbc commented Jun 21, 2021 •
edited
Loading

implement Task#2 in Issue #1162

Changes proposed in this pull request:

  • Modify Doxyfile to
    • log warn into file
    • warning undocumented
  • Add doxypy parser to parse warning log from doxygen
  • Log undocumented by sphinx
  • Ignore some useless warnings

Current output:
2021-06-22-000707_3839x1006_scrot

@cmsxbc
Copy link
Contributor Author

cmsxbc commented Jun 21, 2021

I will finish it in 1 week (if everything goes as expected.

@cmsxbc cmsxbc marked this pull request as ready for review June 22, 2021 15:50
@cmsxbc
Copy link
Contributor Author

cmsxbc commented Jun 22, 2021

Sorry for buggy, I just found that the warning is not trigger by ci, I will try to fix it now...

@cmsxbc
Copy link
Contributor Author

cmsxbc commented Jun 23, 2021

I just ignored all undocumented warnings because it will block CI and currently doc-builiding treat all warnings as error.And I think this pr should focus on feature 0 0.
Sorry for many commits and messages after trigger "ready for review", but now it's ready for review @outoftardis @PetrovKP .

@cmsxbc
Copy link
Contributor Author

cmsxbc commented Jun 23, 2021

Sorry for another message...
I just find that I had misunderstood the task... All necessary undocumented instances are just in doxygen's output xmls...It's not necessary to parse warning log(and I had to do many manually ignored(like setter/getter) instead of just configuring doxygen or the presented function.) ...I'd like to close this PR ....
Sorry again for this nonsense....

@cmsxbc cmsxbc closed this Jun 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@outoftardis outoftardis Awaiting requested review from outoftardis

@averbukh averbukh Awaiting requested review from averbukh

@Vika-F Vika-F Awaiting requested review from Vika-F

@PetrovKP PetrovKP Awaiting requested review from PetrovKP

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@cmsxbc